/*! \file bcmltm_sysm.c
 *
 * Logical Table Manager - System Manager Integration
 *
 * This file contains the LTM implementation for the integration
 * to the System Manager.
 */
/*
 * Copyright: (c) 2018 Broadcom. All Rights Reserved. "Broadcom" refers to 
 * Broadcom Limited and/or its subsidiaries.
 * 
 * Broadcom Switch Software License
 * 
 * This license governs the use of the accompanying Broadcom software. Your 
 * use of the software indicates your acceptance of the terms and conditions 
 * of this license. If you do not agree to the terms and conditions of this 
 * license, do not use the software.
 * 1. Definitions
 *    "Licensor" means any person or entity that distributes its Work.
 *    "Software" means the original work of authorship made available under 
 *    this license.
 *    "Work" means the Software and any additions to or derivative works of 
 *    the Software that are made available under this license.
 *    The terms "reproduce," "reproduction," "derivative works," and 
 *    "distribution" have the meaning as provided under U.S. copyright law.
 *    Works, including the Software, are "made available" under this license 
 *    by including in or with the Work either (a) a copyright notice 
 *    referencing the applicability of this license to the Work, or (b) a copy 
 *    of this license.
 * 2. Grant of Copyright License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    copyright license to reproduce, prepare derivative works of, publicly 
 *    display, publicly perform, sublicense and distribute its Work and any 
 *    resulting derivative works in any form.
 * 3. Grant of Patent License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    patent license to make, have made, use, offer to sell, sell, import, and 
 *    otherwise transfer its Work, in whole or in part. This patent license 
 *    applies only to the patent claims licensable by Licensor that would be 
 *    infringed by Licensor's Work (or portion thereof) individually and 
 *    excluding any combinations with any other materials or technology.
 *    If you institute patent litigation against any Licensor (including a 
 *    cross-claim or counterclaim in a lawsuit) to enforce any patents that 
 *    you allege are infringed by any Work, then your patent license from such 
 *    Licensor to the Work shall terminate as of the date such litigation is 
 *    filed.
 * 4. Redistribution
 *    You may reproduce or distribute the Work only if (a) you do so under 
 *    this License, (b) you include a complete copy of this License with your 
 *    distribution, and (c) you retain without modification any copyright, 
 *    patent, trademark, or attribution notices that are present in the Work.
 * 5. Derivative Works
 *    You may specify that additional or different terms apply to the use, 
 *    reproduction, and distribution of your derivative works of the Work 
 *    ("Your Terms") only if (a) Your Terms provide that the limitations of 
 *    Section 7 apply to your derivative works, and (b) you identify the 
 *    specific derivative works that are subject to Your Terms. 
 *    Notwithstanding Your Terms, this license (including the redistribution 
 *    requirements in Section 4) will continue to apply to the Work itself.
 * 6. Trademarks
 *    This license does not grant any rights to use any Licensor's or its 
 *    affiliates' names, logos, or trademarks, except as necessary to 
 *    reproduce the notices described in this license.
 * 7. Limitations
 *    Platform. The Work and any derivative works thereof may only be used, or 
 *    intended for use, with a Broadcom switch integrated circuit.
 *    No Reverse Engineering. You will not use the Work to disassemble, 
 *    reverse engineer, decompile, or attempt to ascertain the underlying 
 *    technology of a Broadcom switch integrated circuit.
 * 8. Termination
 *    If you violate any term of this license, then your rights under this 
 *    license (including the license grants of Sections 2 and 3) will 
 *    terminate immediately.
 * 9. Disclaimer of Warranty
 *    THE WORK IS PROVIDED "AS IS" WITHOUT WARRANTIES OR CONDITIONS OF ANY 
 *    KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WARRANTIES OR CONDITIONS OF 
 *    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR 
 *    NON-INFRINGEMENT. YOU BEAR THE RISK OF UNDERTAKING ANY ACTIVITIES UNDER 
 *    THIS LICENSE. SOME STATES' CONSUMER LAWS DO NOT ALLOW EXCLUSION OF AN 
 *    IMPLIED WARRANTY, SO THIS DISCLAIMER MAY NOT APPLY TO YOU.
 * 10. Limitation of Liability
 *    EXCEPT AS PROHIBITED BY APPLICABLE LAW, IN NO EVENT AND UNDER NO LEGAL 
 *    THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE 
 *    SHALL ANY LICENSOR BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, 
 *    INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF 
 *    OR RELATED TO THIS LICENSE, THE USE OR INABILITY TO USE THE WORK 
 *    (INCLUDING BUT NOT LIMITED TO LOSS OF GOODWILL, BUSINESS INTERRUPTION, 
 *    LOST PROFITS OR DATA, COMPUTER FAILURE OR MALFUNCTION, OR ANY OTHER 
 *    COMMERCIAL DAMAGES OR LOSSES), EVEN IF THE LICENSOR HAS BEEN ADVISED OF 
 *    THE POSSIBILITY OF SUCH DAMAGES.
 */

#include <shr/shr_types.h>
#include <shr/shr_debug.h>
#include <shr/shr_error.h>
#include <shr/shr_sysm.h>

#include <bsl/bsl.h>

#include <bcmmgmt/bcmmgmt_sysm.h>

#include <bcmptm/bcmptm.h>

#include <bcmltm/bcmltm.h>
#include <bcmltm/bcmltm_table_op_pt_info.h>
#include <bcmltm/bcmltm_sysm.h>


/*******************************************************************************
 * Local definitions
 */

/* BSL Module */
#define BSL_LOG_MODULE BSL_LS_BCMLTM_INIT


/*******************************************************************************
 * Private functions
 */

/*!
 * \brief LTM callbacks within PTM registration function.
 *
 * Register all of the LTM function callbacks supplied to the PTM
 * to permit CTH wrapper functions that protect LTM internal state.
 *
 * \param [in] unit Unit number.
 *
 * \return None
 */
static void
ltm_sysm_ptm_callbacks_register(int unit)
{
    bcmptm_lt_stat_increment_register(unit, bcmltm_stats_increment_lt);

    bcmptm_pt_status_mreq_keyed_lt_register(unit,
                                   bcmltm_pt_status_mreq_keyed_lt);

    bcmptm_pt_status_mreq_indexed_lt_register(unit,
                                     bcmltm_pt_status_mreq_indexed_lt);

    bcmptm_pt_status_ireq_hash_lt_register(unit,
                                  bcmltm_pt_status_ireq_hash_lt);

    bcmptm_pt_status_ireq_op_register(unit,
                                      bcmltm_pt_status_ireq_op);
}

/*!
 * \brief LTM callbacks within PTM unregistration function.
 *
 * Unregister all of the LTM function callbacks supplied to the PTM
 * to permit CTH wrapper functions that protect LTM internal state.
 * The LTM may cleanup its internal state safely after these callbacks
 * are been disabled.
 *
 * \param [in] unit Unit number.
 *
 * \return None
 */
static void
ltm_sysm_ptm_callbacks_unregister(int unit)
{
    bcmptm_lt_stat_increment_register(unit, NULL);

    bcmptm_pt_status_mreq_keyed_lt_register(unit, NULL);

    bcmptm_pt_status_mreq_indexed_lt_register(unit, NULL);

    bcmptm_pt_status_ireq_hash_lt_register(unit, NULL);

    bcmptm_pt_status_ireq_op_register(unit, NULL);
}

/*!
 * \brief LTM initialization function.
 *
 * LTM is requested to initialize.
 *
 * \param [in] instance_category System manager instance category.
 * \param [in] unit Unit number.
 * \param [in] comp_data Pointer to the component context.
 * \param [in] warm Indicates cold or warm start.
 * \param [out] blocking_component Blocking component.
 *
 * \return SHR_SYSM_RV_DONE on success, SHR_SYSM_RV_ERROR on error and
 *         SHR_SYSM_RV_BLOCKED when waiting on other component.
 */
static shr_sysm_rv_t
ltm_sysm_init(shr_sysm_categories_t instance_category,
              int unit,
              void *comp_data,
              bool warm,
              uint32_t *blocking_component)
{
    /* Check dependencies */
    if (!shr_sysm_is_comp_complete(BCMMGMT_DRD_COMP_ID,
                                   instance_category,
                                   unit)) {
        *blocking_component = BCMMGMT_DRD_COMP_ID;
        return SHR_SYSM_RV_BLOCKED;
    }
    if (!shr_sysm_is_comp_complete(BCMMGMT_LTD_COMP_ID,
                                   instance_category,
                                   unit)) {
        *blocking_component = BCMMGMT_LTD_COMP_ID;
        return SHR_SYSM_RV_BLOCKED;
    }

    /* Initialize LTM */
    if (SHR_FAILURE(bcmltm_init(unit, warm))) {
        return SHR_SYSM_RV_ERROR;
    }

    return SHR_SYSM_RV_DONE;
}

/*!
 * \brief LTM config function.
 *
 * LTM is requested to configure.
 *
 * \param [in] instance_category System manager instance category.
 * \param [in] unit Unit number.
 * \param [in] comp_data Pointer to the component context.
 * \param [in] warm Indicates cold or warm start.
 * \param [out] blocking_component Blocking component.
 *
 * \return SHR_SYSM_RV_DONE on success, SHR_SYSM_RV_ERROR on error and
 *         SHR_SYSM_RV_BLOCKED when waiting on other component.
 */
static shr_sysm_rv_t
ltm_sysm_comp_config(shr_sysm_categories_t instance_category,
                     int unit,
                     void *comp_data,
                     bool warm,
                     uint32_t *blocking_component)
{
    /* Check dependencies */

    /*
     * Although LTM currently does not need to do anything in this state,
     * it checks that relevant dependent components have completed
     * this state in order to report the correct status to other components
     * that need to take actions.
     */
    if (!shr_sysm_is_comp_complete(BCMMGMT_PTM_COMP_ID,
                                   instance_category,
                                   unit)) {
        *blocking_component = BCMMGMT_PTM_COMP_ID;
        return SHR_SYSM_RV_BLOCKED;
    }

    return SHR_SYSM_RV_DONE;
}

/*!
 * \brief LTM pre_config function.
 *
 * LTM is requested to pre-configure.
 *
 * \param [in] instance_category System manager instance category.
 * \param [in] unit Unit number.
 * \param [in] comp_data Pointer to the component context.
 * \param [in] warm Indicates cold or warm start.
 * \param [out] blocking_component Blocking component.
 *
 * \return SHR_SYSM_RV_DONE on success, SHR_SYSM_RV_ERROR on error and
 *         SHR_SYSM_RV_BLOCKED when waiting on other component.
 */
static shr_sysm_rv_t
ltm_sysm_pre_config(shr_sysm_categories_t instance_category,
                    int unit,
                    void *comp_data,
                    bool warm,
                    uint32_t *blocking_component)
{
    /* Check dependencies */

    if (!shr_sysm_is_comp_complete(BCMMGMT_PTM_COMP_ID,
                                   instance_category,
                                   unit)) {
        *blocking_component = BCMMGMT_PTM_COMP_ID;
        return SHR_SYSM_RV_BLOCKED;
    }

    /* Turn on the PTM callbacks once the LTM init of LT state
     * is completed.
     */
    ltm_sysm_ptm_callbacks_register(unit);

    

    return SHR_SYSM_RV_DONE;
}


/*!
 * \brief LTM shutdown function.
 *
 * LTM is requested to being shutdown completely.
 *
 * \param [in] instance_category System manager instance category.
 * \param [in] unit Unit number.
 * \param [in] comp_data Pointer to the component context.
 * \param [in] warm Indicates cold or warm start.
 * \param [out] blocking_component Blocking component.
 *
 * \return SHR_SYSM_RV_DONE on success, SHR_SYSM_RV_ERROR on error and
 *         SHR_SYSM_RV_BLOCKED when waiting on other component.
 */
static shr_sysm_rv_t
ltm_sysm_shutdown(shr_sysm_categories_t instance_category,
                  int unit,
                  void *comp_data,
                  bool warm,
                  uint32_t *blocking_component)
{
    /* Turn off the PTM callbacks before LT state is discarded. */
    ltm_sysm_ptm_callbacks_unregister(unit);

    if (SHR_FAILURE(bcmltm_cleanup(unit))) {
        return SHR_SYSM_RV_ERROR;
    }

    return SHR_SYSM_RV_DONE;
}

/*!
 * \brief LTM System manager init struct.
 */
static shr_sysm_cb_func_set_t ltm_sysm_handler = {
    /*! Initialization. */
    .init        = ltm_sysm_init,

    /*! Component configuration. */
    .comp_config = ltm_sysm_comp_config,

    /*! Pre-configuration. */
    .pre_config  = ltm_sysm_pre_config,

    /*! Run. */
    .run         = NULL,

    /*! Stop. */
    .stop        = NULL,

    /*! Shutdown. */
    .shutdown    = ltm_sysm_shutdown
};

/*******************************************************************************
 * Public functions
 */

/*
 * Called by System Manager to start LTM.
 */
int
bcmltm_start(void)
{
    SHR_FUNC_ENTER(BSL_UNIT_UNKNOWN);

    SHR_IF_ERR_EXIT
        (shr_sysm_register(BCMMGMT_LTM_COMP_ID,
                           SHR_SYSM_CAT_UNIT,
                           &ltm_sysm_handler,
                           NULL));
 exit:
    SHR_FUNC_EXIT();
}
